CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/devices (Get)
In This Topic
    Get/projects/{projectId}/devices
    In This Topic
    Description
    returns an array of devices in the project optionally filtered by port prefix
    Parameters
    NameDescriptionData Type
    projectIdthe id of the projectstring
    portPrefixthe port prefix used to filter the devices. The "MASTER_" prefix is removed from the port_type_id and the device list is filtered to the port types that start with the portPrefix.string
    200 Response

    The response body is of type Array[deviceData].

    array of devices matching criteria

    Overview

    Array[deviceData]
    deviceData
    CIMPLICITY class definition
    deviceId : string
    the device ID
    portTypeId : string
    the port type ID
    description : string
    the device description
    networkAddr : string
    the network address
    pluginData : string
    the data for the OPC UA browse service plugin
    Fault Responses
    FaultDescription
    404This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    See Also
    All Operations Resource Group | CIMPLICITY REST API Web Service

     

     

    © 2021 All Rights Reserved.